%Olivier Van den Plas
%CANBOT 2013-2014

%--------------------------------------------------------------------

\documentclass[a4paper,12pt]{book}

\usepackage[dutch]{babel}
\usepackage{color}
\usepackage[usenames,dvipsnames,svgnames,table]{xcolor}
\usepackage{graphicx}
\usepackage{float}
\usepackage{wrapfig}
\usepackage{rotating}
\usepackage{doxygen}
\usepackage{hyperref}
\hypersetup{
	colorlinks,
	citecolor=black,
	filecolor=black,
	linkcolor=black,
	urlcolor=blue
	}
%\usepackage{amssymb}
%\usepackage{amsmath}
\newcommand{\HRule}{\rule{\linewidth}{0.5mm}}
\newcommand{\dgr}{^\circ}
\usepackage{lscape}
\usepackage{pdflscape}
\usepackage{longtable}
%\usepackage[top=1.5cm, bottom=1.5cm, left=1.5cm, right=1.5cm]{geometry}
\newcommand{\tab}{\hspace{2em}}
\newcommand{\ts}{\textsuperscript}
\newcommand{\lap}{\mathcal{L}}
\newcommand{\pijl}{$\rightarrow $ }
\newcommand{\disney}{\partial}
\newcommand{\rn}[1]{\uppercase\expandafter{\romannumeral #1\relax}}
%\usepackage{subfig}
%\usepackage{listings}
\usepackage{scrtime}

\newenvironment{myindentpar}[1]%
 {\begin{list}{}%
         {\setlength{\leftmargin}{#1}}%
         \item[]%
 }
 {\end{list}}


\usepackage{etoolbox}
\patchcmd{\chapter}{plain}{headings}{}{}

\parindent=0pt

%\usepackage{draftwatermark}
%%\usepackage[firstpage]{draftwatermark}
%
%% Use the following to make modification
%\SetWatermarkAngle{60}
%%\SetWatermarkColor[rgb]{0,1,0}
%\SetWatermarkLightness{0.90}
%%\SetWatermarkFontSize{20cm}
%\SetWatermarkScale{1.5}
%\SetWatermarkText{Olivier Van den Plas \today}
%%\SetWatermarkText{Draft \today}


%------------------------------------------------------------------
\begin{document}
\selectlanguage{dutch}
\author{Team B}
\title{CANBOT Team B 2013-2014}
\maketitle

\thispagestyle{plain}

\chapter{Algemene Gegevens}%-----------------------------------------------------------------------

\section{Groepsgegevens}


	\begin{table}[H]
		\centering
		\begin{tabular}{|l|l|l|}
		\hline
		CEO			&	Ben			&	calus.ben@gmail.com			\\ 
					&	Philippe	&	vanmullem.philippe@gmail.com\\ \hline
		SWM			&	Yannick		&	yannsonnboys01@gmail.com	\\ \hline
		Wifi		&	Roel		&	postelmansroel@gmail.com	\\ 
					&	Stijn		&	stijnvinck85@gmail.com		\\ \hline
		Strategy 	&	Ben			&	calus.ben@gmail.com			\\ 
					&	Simon		&	simondejager@gmail.com		\\ 
					&	Philippe	&	vanmullem.philippe@gmail.com\\
					&	Tom			&								\\ \hline
		Low Level 	&	Thomas		&	thomas.vanengeland@gmail.com\\ 
					&	Johan		&	spruyt.johan@gmail.com		\\ \hline
		Doc			&	Olivier		&	oliviervdplas@gmail.com		\\ \hline
		\end{tabular}
		\caption{groepsgegevens}
	\end{table}
	
\clearpage
		
\section{Communicatiegegevens}

	Deze afbeelding hebben we gekregen van onze collega's van het visieteam.

			\begin{figure}[H]
				\centering
				\includegraphics[width=0.8\textwidth]{Afbeeldingen/udp}
				\caption{Formaat van het UDP pakket}
				\label{udp}
			\end{figure}	

\section{Doxygen}

	\subsection{Installatie}
	
		Vanuit de linux terminal:
	
		\tab {\ttfamily sudo apt-get install doxygen}
		
		Doxygen is nu ge\"installeerd
		
	\subsection{De config file}
	
		Vanuit de terminal kunnen we met het commando {\ttfamily doxygen -g config} een file genereren, genaamd $"$config$"$. deze bevat alle configuraties i.v.m. de gewenste tekstuele output. Olivier zal een config file aanmaken, die kan gebruikt worden op alle bestanden. De config file wordt mee in de map met code geplaatst. Door daarna het commando {\ttfamily doxygen config} uit te voeren worden de gevraagde bestanden gegenereerd. De gegenereerde latex file moet nog gecompileerd worden. Dit kan eenvoudig door in de latex map {\ttfamily make} te gebruiken (als de pdflatex compiler op de computer ge\"installeerd is). De resulterende pdf ({\ttfamily refman.pdf}) zou dan de nodige informatie over de code moeten bevatten.
		
	\subsection{Doxygen commentaren in uw code}
	
		Op onderstaande link vindt je een uitgebreide opsomming van het becommentari\"eren van uw code.
	
		\url{http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html}
		
		Commentaren worden nu geschreven met een extra teken
		
		vb.:
		
		\begin{itemize}
			\item {\ttfamily //} wordt {\ttfamily ///} of {\ttfamily //!}
			\item {\ttfamily /*   ...   */} wordt {\ttfamily /**  ...  */} of {\ttfamily /*!  ...  */}
		\end{itemize}
		
		Bij het schrijven van commentaar bij een bepaalde lijn uit de code doen we dat met het kleiner dan teken.
		vb. bij een variabele:
		
		\vspace{1em}
		{\ttfamily int pos\_x \tab ///$<$ x coordinaat van het doel}
		
		\vspace{1em}
		
		Op de bovenvermelde website staan ook nog concretere (lees correctere) manieren om bv een variabele te becommentari\"eren met bv. {\ttfamily \textbackslash var}. Een volledige lijst voor ook het benoemen van vb. structs, defines ... is te lezen op de website.



\chapter{Documentatie bij Wifi code}
\input{classServer}
\input{classBuffer}
\input{structPackage}
\input{structInfo}
\input{structPosition}
\input{structUdp__header}
\input{structUdp__package}

\chapter{Documentatie bij Strategy code}
\input{classRobot}
\input{structPosition}

\chapter{Documentatie bij Low Level code}
\input{classCanBotLL}
\input{classSerial}

\vspace{15em}



\hrule
\vspace{1em}

Document laatst aangepast op \today \, \thistime .




\end{document}
